home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 10 / AACD 10.iso / AACD / Programming / mpatrol / doc / README < prev    next >
Text File  |  2000-05-16  |  5KB  |  123 lines
  1. README FOR THE MPATROL LIBRARY DOCUMENTATION
  2.  
  3.  
  4. This directory may contain preformatted documentation for the mpatrol library.
  5. The documents will have been generated from the TeXinfo source (or from the
  6. LaTeX source of the reference card) using a variety of tools and are provided
  7. partly for convenience and partly for people who do not have suitable formatting
  8. tools installed on their system.  In all cases these documents can be
  9. regenerated from the source, although there may be slight changes in some files
  10. due to differences in the systems that they were generated on.  Note that the
  11. UNIX manual pages are not considered part of this documentation (although they
  12. are kept up to date) and are located in a separate directory.
  13.  
  14.  
  15. The following files are provided with the main distribution and contain all of
  16. the information necessary to generate each of the preformatted files.
  17.  
  18.   * mpatrol.texi
  19.         Format:    GNU TeXinfo
  20.                    http://texinfo.org/
  21.         Notes:     The unprocessed source of the mpatrol manual.
  22.  
  23.   * refcard.tex
  24.         Format:    LaTeX
  25.                    http://www.tug.org/
  26.         Notes:     The unprocessed source of the reference card.
  27.  
  28.   * images/mpatrol.txt
  29.         Format:    ASCII text
  30.                    http://www.bbsinc.com/iso8859.html
  31.         Notes:     The mpatrol logo required by the ASCII text, GNU Info and
  32.                    AmigaGuide versions of the mpatrol manual.
  33.  
  34.   * images/mpatrol.jpg
  35.         Format:    Joint Photographic Experts Group (JPEG) colour image
  36.                    http://www.jpeg.org/
  37.         Notes:     The mpatrol logo required by the HTML version of the mpatrol
  38.                    manual.
  39.  
  40.   * images/mpatrol.eps
  41.         Format:    Adobe Encapsulated Postscript (EPS) greyscale image
  42.                    http://www.adobe.com/
  43.         Notes:     The mpatrol logo required by the DVI and Postscript versions
  44.                    of the mpatrol manual.
  45.  
  46.   * images/mpatrol.pdf
  47.         Format:    Portable Network Graphics (PNG) colour image
  48.                    http://www.cdrom.com/pub/png/
  49.         Notes:     The mpatrol logo required by the PDF version of the mpatrol
  50.                    manual.
  51.  
  52.  
  53. The following files are all formatted for on-line documentation.  They generally
  54. contain little or no formatting codes, leaving the final formatting up to the
  55. viewer program.
  56.  
  57.   * mpatrol.doc
  58.         Format:    ASCII text
  59.                    http://www.bbsinc.com/iso8859.html
  60.         Generator: GNU MakeInfo
  61.                    http://texinfo.org/
  62.         Viewer:    Any text viewer
  63.         Notes:     Plain text with no formatting codes.
  64.  
  65.   * mpatrol.info
  66.         Format:    GNU Info
  67.                    http://texinfo.org/
  68.         Generator: GNU MakeInfo
  69.                    http://texinfo.org/
  70.         Viewer:    GNU Info
  71.         Notes:     Contains hypertext links but no formatting codes.
  72.  
  73.   * mpatrol.guide
  74.         Format:    AmigaGuide
  75.                    http://www.lysator.liu.se/amiga/code/guide/amigaguide.guide
  76.         Generator: GNU MakeGuide
  77.                    http://www.aminet.org/~aminet/dirs/aminet/dev/gg/
  78.         Viewer:    AmigaGuide or MultiView
  79.         Notes:     Contains hypertext links with basic formatting codes.
  80.  
  81.   * mpatrol.html
  82.         Format:    Hypertext Markup Language (HTML)
  83.                    http://www.w3c.org/MarkUp/
  84.         Generator: GNU MakeInfo
  85.                    http://texinfo.org/
  86.         Viewer:    Any web browser
  87.         Notes:     Contains hypertext links with formatting codes, but contains
  88.                    links to JPEG images rather than embedding them.
  89.  
  90.  
  91. The following files are all formatted for printed manuals.  All can be viewed
  92. with a variety of programs, not just the ones listed here.
  93.  
  94.   * mpatrol.dvi & refcard.dvi
  95.         Format:    Device Independent format (DVI)
  96.                    http://www.tug.org/
  97.         Generator: TeX
  98.                    http://www.tug.org/
  99.         Viewer:    XDVI
  100.                    http://www.math.berkeley.edu/~vojta/xdvi.html
  101.         Notes:     Contains links to EPS images rather than embedding them.
  102.                    Bitmapped fonts are built on demand to a suitable resolution
  103.                    when viewing or printing.
  104.  
  105.   * mpatrol.ps & refcard.ps
  106.         Format:    Adobe Postscript
  107.                    http://www.adobe.com/
  108.         Generator: DVIPS
  109.                    http://www.radicaleye.com/dvips.html
  110.         Viewer:    Ghostview
  111.                    http://www.cs.wisc.edu/~ghost/ghostview/
  112.         Notes:     Contains embedded EPS images and Postscript Type 1 fonts.
  113.  
  114.   * mpatrol.pdf & refcard.pdf
  115.         Format:    Adobe Portable Document Format (PDF)
  116.                    http://www.adobe.com/
  117.         Generator: PDFTeX
  118.                    http://www.tug.org/applications/pdftex/
  119.         Viewer:    XPDF
  120.                    http://www.foolabs.com/xpdf/
  121.         Notes:     Contains hypertext links along with embedded PNG images and
  122.                    Postscript Type 1 fonts.
  123.